<HTML>
<HEAD>
<TITLE>HELP - examplesgroupCmd.page</TITLE>
<script type="text/javascript">
  var relPathToCommmon = "../../common/";
  var relPathToHelpDir = "../../common/help/";
</script>
<script type="text/javascript" src="../../common/jsdyn.js" language="JavaScript"></script>
<script type="text/javascript" src="../../common/js.js" language="JavaScript"></script>
<script type="text/javascript" src="leftmenu.js" language="JavaScript"></script>
<script type="text/javascript">
  var toSearchPage     = "_search','../../search";
  Body1();
</script>
<div class="headerPage">HELP - examplesgroupCmd.page</div>
<div class="path"><a href="#" OnMouseOver="link('','../../index',this)" class="pathLink">Help</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_dir','CommandReference0',this)" class="pathLink">Command Reference</A><img src="../../common/path-arrow.gif" class="path-arrow"><span class="pathNonLink">examplesgroupCmd.page</span></div>
<script type="text/javascript">
 Body2();
 BodyLeftMenuStart();
WriteLeftMenu("","","","");
 BodyLeftMenuEnd();
 Body3();
</script>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_file','examplesgroupCmd_page0','_description',this)" class="tabLinkInActive">Description</a></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Overview</span></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Included files</span></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Included by</span></span>
<span class="tabActive"><a href="#" OnMouseOver="linkTab('_file','examplesgroupCmd_page0','_source',this)" class="tabLinkActive">Source</a></span>
<script type="text/javascript">
 Body4();
</script>
<div class="contentAirTop"></div>
<pre class="codeExamples">
/** 
\page examplesgroupCmd 
!!! Define a examples group documentaion block
This command defines a examples group, much like a page (defgroupCmd) or unit (unitCmd). 
The difference is that example groups can contain source code examples which are related 
to the directory in which the groups is defined. 


!Syntax:
\code
\examplesgroup MyGroup
\examplesgroup "Group name with spaces"
\endcode

Example groups are tied to the directory they are specified in and have their own 'tab' 
on directory pages (far right).  

!Layout
To control the layout we have the EXAMPLE_GROUP_USE_TABS option, which controls wheter 
the examples are show as classic overview tables or using tab for each example group, and 
again a tab for each example within a group. Default is to show using tabs. 
For the standard examples both in example groups and all other entities we also 
have two options for showing the examples using EXAMPLES_USE_TABS. If set to 
YES (default), DoxyS will display examples on all pages as tabs. If set to NO 
examples will be shown (classical) using expand/collapse icons.

!Adding examples to a group
Examples are added to an example group like examples for classes, pages, functions etc. 
using the \\example (exampleCmd) command. 

!DoxyS.ignore
When including examples using a line like this:
\code
\example _examples/included_example_1.cpp
\endcode
It might a good idea to exclude the '_examples' directory using a 'DoxyS.ignore' 
file with content like this:
\code
_examples
\endcode


\example
/**
\examplesgroup "My examples"
This is the breif description of the examples group.
More description here.

\ example
void someFunction()
{
	float iFloat = 10.4;
	OverloadedInGroup( iFloat );
	Set( iFloat, 4.5 );
}
\ endexample

\ example _examples/included_example_1.cpp
\endds_doc
\endexample

\see exampleCmd

\note Autolinking to examples group names with spaces. Remember to put the examples group name in quotation marks 
      to name groups in the place where you refer to the examples group just like with directories. E.g. 
      '... you can also go to "My examples group with spaces" to see the ....'
*/</pre><div class="contentAirBottom"></div>
<script type="text/javascript">
 Body5();
Statistics("","","","","");
 Body6();
SetPageTab('_file','_source');
</script>
